CxVhsEditor Methods
The CxVhsEditor object contains the following methods:
Connect
The Connect method connects the object to a service.
Syntax
Connect(DomainSiteService As String)
Parameters
| Parameter | Required | Description |
|---|---|---|
|
DomainSiteService |
Yes |
The [Domain]Site.Service to which to connect. The domain is optional. The service must be a valid one. |
Remarks
Returns 0 if successful and a non-zero value if the connection failed.
Example
The following example connects the Client object to the CYGDEMO.<SVC> on domain 5410:
Sub'
Dim VhsEditor
Set VhsEditor = CreateObject("CxEditors.CxVhsEditor")
VhsEditor.Connect("[5410]CYGDEMO.VHS")
End Sub
Copy
The Copy method launches a New dialog box initialized with the information in the specified record.
Syntax
Copy(QueueKey As String) As Integer
Parameters
| Parameter | Required | Description |
|---|---|---|
|
QueueKey |
Yes |
The database queue key of the record to copy. |
Remarks
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
| 1 | OK button was pressed. | |
| 2 | Cancel button was pressed. |
Example
The following example launches a Copy or New dialog box for the record "0000012345."
Delete
The Delete method launches a Delete dialog box initialized with the information in the specified record.
Syntax
Delete(QueueKey As String) As Integer
Parameters
| Parameter | Required | Description |
|---|---|---|
|
QueueKey |
Yes |
The database queue key of the record to delete. |
Remarks
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
| 1 | OK button was pressed. | |
| 2 | Cancel button was pressed. |
Example
The following example launches the specified Delete dialog box for record "0000012345":
Disconnect
The Disconnect method disconnects from the connected service.
Syntax
Disconnect() As Integer
Remarks
The Disconnect method returns 0 if successful and a non-zero value if the disconnect failed.
Example
The following example disconnects the Client object from the connected service, and pops a message box if it is unsuccessful:
Sub Svc.Disconnect()
<SvcClient>.Disconnect()
MsgBox "Service has disconnected."
If <SvcClient>.Disconnect <> 0
Then
MsgBox "Failed to disconnect."
End If
End Sub
DisplayValues
The DisplayValues method displays a History Values dialog box for the specified point.
Syntax
DisplayValues(PointTag As String) As Integer
Parameters
| Parameter | Required | Description |
|---|---|---|
|
PointTag |
Yes |
The tag of the point for which to display values. The point tag can be in one of the following forms:
|
Remarks
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
| 1 | The dialog box closed successfully. |
Example
The following example displays a History Values dialog box for point "CYGDEMO.UIS.00001388."
Sub
Dim iRet
iRet= VhsEditor.DisplayValues("CYGDEMO.UIS.00001388")
MsgBox iRet
End Sub
Edit
The Edit method launches an editor dialog box initialized with the information in the specified record.
Syntax
Edit(QueueKey As String) As Integer
Parameters
| Parameter | Required | Description |
|---|---|---|
|
QueueKey |
Yes |
The database queue key of the record to edit. |
Remarks
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
| 1 | OK button was pressed. | |
| 2 | Cancel button was pressed. |
Example
The following example launches an editor dialog box for the record "0000012345":
New
The New method launches a Create dialog box.
Syntax
New() As Integer
Remarks
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
| 1 | OK button was pressed. | |
| 2 | Cancel button was pressed. |
Example
The following example launches the specified editor dialog box:
